<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>aiengine: xaietile_lock.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">aiengine
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xaietile__lock_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">xaietile_lock.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>Header file lock acquire/release functions. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who     Date     Changes
</p>
<hr/>
<p>
1.0  Naresh  03/14/2018  Initial creation
1.1  Naresh  07/11/2018  Updated copyright info
1.2  Nishad  12/05/2018  Renamed ME attributes to AIE
</pre> </div><table class="memberdecls">
<tr class="memitem:aac78deb03ca97e5eefa793234a7459e8"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xaietile__lock_8h.html#aac78deb03ca97e5eefa793234a7459e8">XAieTile_LockAcquire</a> (<a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *TileInstPtr, u8 LockId, u8 LockVal, u32 TimeOut)</td></tr>
<tr class="memdesc:aac78deb03ca97e5eefa793234a7459e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API is used to acquire the specified lock with or without value.  <a href="#aac78deb03ca97e5eefa793234a7459e8">More...</a><br/></td></tr>
<tr class="separator:aac78deb03ca97e5eefa793234a7459e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a359377dd95d79733d83e2a0ca8c9672e"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xaietile__lock_8h.html#a359377dd95d79733d83e2a0ca8c9672e">XAieTile_LockRelease</a> (<a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *TileInstPtr, u8 LockId, u8 LockVal, u32 TimeOut)</td></tr>
<tr class="memdesc:a359377dd95d79733d83e2a0ca8c9672e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API is used to release the specified lock with or without value.  <a href="#a359377dd95d79733d83e2a0ca8c9672e">More...</a><br/></td></tr>
<tr class="separator:a359377dd95d79733d83e2a0ca8c9672e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aac78deb03ca97e5eefa793234a7459e8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAieTile_LockAcquire </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *&#160;</td>
          <td class="paramname"><em>TileInstPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LockId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LockVal</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>TimeOut</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API is used to acquire the specified lock with or without value. </p>
<p>Lock acquired without value if LockVal==0xFF. This API can be blocking or non- blocking based on the TimeOut value. If TimeOut==0, then API behaves in a non-blocking fashion and returns immediately after the first read request. If TimeOut&gt;0, then API becomes blocking and will issue the read request until the acquire is successful or time out happens, whichever occurs first.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TileInstPtr</td><td>- Pointer to the Tile instance. </td></tr>
    <tr><td class="paramname">LockId</td><td>- Lock value index, ranging from 0-15. </td></tr>
    <tr><td class="paramname">LockVal</td><td>- Lock value used for acquire. If set to 0xFF, lock acquired with no value. </td></tr>
    <tr><td class="paramname">TimeOut</td><td>- Time-out value for which the read request needs to be repeated. Value to be specified in usecs.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if acquire successful, else 0.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_aie_gbl___reg_locks.html#ac46e8aed2e657415f10a9ec4accd7cdc">XAieGbl_RegLocks::AcqNv</a>, <a class="el" href="struct_x_aie_gbl___reg_locks.html#af69bfbf73fde4d5cdd62192ba35109f0">XAieGbl_RegLocks::AcqNvOff</a>, <a class="el" href="struct_x_aie_gbl___reg_locks.html#ac9b6d40a5a1060ed705268b472038122">XAieGbl_RegLocks::AcqV0</a>, <a class="el" href="struct_x_aie_gbl___reg_locks.html#a7f06c3c7efef2f8833ad501087b62b6f">XAieGbl_RegLocks::AcqV0Off</a>, <a class="el" href="struct_x_aie_gbl___reg_locks.html#a12c16d6a586ad444265884f016d5b3cc">XAieGbl_RegLocks::AcqV1</a>, <a class="el" href="struct_x_aie_gbl___reg_locks.html#a99294db11ce5393014055946bba269a9">XAieGbl_RegLocks::AcqV1Off</a>, <a class="el" href="struct_x_aie_gbl___reg_fld_attr.html#a95f0d60188c5baf7612b662f58a98617">XAieGbl_RegFldAttr::Lsb</a>, <a class="el" href="struct_x_aie_gbl___reg_fld_attr.html#a235949ebe8e30fb2b6ee52c0b3c6b760">XAieGbl_RegFldAttr::Mask</a>, <a class="el" href="struct_x_aie_gbl___tile.html#a7c04a73941e64980a264a9d529fbb571">XAieGbl_Tile::TileAddr</a>, and <a class="el" href="struct_x_aie_gbl___tile.html#aadd948557d2723faa0cf47419e7d8a6e">XAieGbl_Tile::TileType</a>.</p>

<p>Referenced by <a class="el" href="xsock__clitest_8c.html#a0ddf1224851353fc92bfbff6f499fa97">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a359377dd95d79733d83e2a0ca8c9672e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAieTile_LockRelease </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *&#160;</td>
          <td class="paramname"><em>TileInstPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LockId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>LockVal</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>TimeOut</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API is used to release the specified lock with or without value. </p>
<p>Lock released without value if LockVal==0xFF. This API can be blocking or non- blocking based on the TimeOut value. If TimeOut==0, then API behaves in a non-blocking fashion and returns immediately after the first read request. If TimeOut&gt;0, then API becomes blocking and will issue the read request until the release is successful or time out happens, whichever occurs first.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TileInstPtr</td><td>- Pointer to the Tile instance. </td></tr>
    <tr><td class="paramname">LockId</td><td>- Lock value index, ranging from 0-15. </td></tr>
    <tr><td class="paramname">LockVal</td><td>- Lock value used for release. If set to 0xFF, lock released with no value. </td></tr>
    <tr><td class="paramname">TimeOut</td><td>- Time-out value for which the read request needs to be repeated. Value to be specified in usecs.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if release successful, else 0.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_aie_gbl___reg_fld_attr.html#a95f0d60188c5baf7612b662f58a98617">XAieGbl_RegFldAttr::Lsb</a>, <a class="el" href="struct_x_aie_gbl___reg_fld_attr.html#a235949ebe8e30fb2b6ee52c0b3c6b760">XAieGbl_RegFldAttr::Mask</a>, <a class="el" href="struct_x_aie_gbl___reg_locks.html#a930190c1039f6b43dddaa620c72425e8">XAieGbl_RegLocks::RelNv</a>, <a class="el" href="struct_x_aie_gbl___reg_locks.html#ab7aaca839f2b982fdb7e7687002851e6">XAieGbl_RegLocks::RelNvOff</a>, <a class="el" href="struct_x_aie_gbl___reg_locks.html#a20b24f39f3f8dcb13c017fe8d386803d">XAieGbl_RegLocks::RelV0</a>, <a class="el" href="struct_x_aie_gbl___reg_locks.html#a7ec8053dc6c232309b72215d16a098f0">XAieGbl_RegLocks::RelV0Off</a>, <a class="el" href="struct_x_aie_gbl___reg_locks.html#a70c6c05475ff4fd17fee34a6acadfd99">XAieGbl_RegLocks::RelV1</a>, <a class="el" href="struct_x_aie_gbl___reg_locks.html#aef120c05a98c4ae6bf3cad0f0eec3e8a">XAieGbl_RegLocks::RelV1Off</a>, <a class="el" href="struct_x_aie_gbl___tile.html#a7c04a73941e64980a264a9d529fbb571">XAieGbl_Tile::TileAddr</a>, and <a class="el" href="struct_x_aie_gbl___tile.html#aadd948557d2723faa0cf47419e7d8a6e">XAieGbl_Tile::TileType</a>.</p>

<p>Referenced by <a class="el" href="xsock__clitest_8c.html#a0ddf1224851353fc92bfbff6f499fa97">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
